home *** CD-ROM | disk | FTP | other *** search
/ Aminet 24 / Aminet 24 (1998)(GTI - Schatztruhe)[!][Apr 1998].iso / Aminet / dev / lang / Regina.lha / rexx.man < prev   
Text File  |  1997-09-14  |  14KB  |  396 lines
  1.  
  2.  
  3. rexx (1)               Commands and Applications                rexx (1)
  4.  
  5.  
  6.  
  7.  
  8. Name  
  9.         rexx - The Regina Rexx interpreter 
  10.  
  11. Syntax  
  12.         ›7mrexx›m [ ›7moptions›m ] [ ›7mscript›m [  ›7mscriptparams›m ]] 
  13.  
  14. Description  
  15.         Rexx  will  read  the  file named as  script and will assume the
  16.         contents of that file to be a Rexx  script  and  interpret  that
  17.         script.  Any parameters following  script will be interpreted as 
  18.         the parameters to the Rexx script.  If  script is not specified, 
  19.         the  Rexx  script to interpret will be read from standard input,
  20.         and interpretation will start when the  whole  script  has  been
  21.         read.  
  22.         If  `-' is specified as ›7mscript›m then the script will be read
  23.         from standard input.  
  24.  
  25. Options  
  26.  
  27.         -tx  
  28.                 Starts interpretation with traceing set to "x".  If  you
  29.                 want  to run your program with tracing set to "all", you
  30.                 can use the option    ›7m-ta.›m  If  only    ›7m-t›m  is
  31.                 specified, "all" is the trace mode set.  
  32.  
  33.         -i  
  34.                 Starts Regina  in  interactive  mode.  No script will be
  35.                 executed.  
  36.  
  37. Built-ins  
  38.         Below is a list of all the standard built-in functions in  Rexx.
  39.         For  a  more  complete  description  of  each  function, see the
  40.         documentation accompanying Regina.  
  41.  
  42.         ABBREV(long,short[,length])  
  43.                 Returns `1' or 0', depending on whether  `short'  is  an
  44.                 abbrevation of `long', or at least `length' characters.  
  45.  
  46.         ABS(number)  
  47.                 Returns the absolute value of `number'.  
  48.  
  49.         ADDRESS()  
  50.                 Returns the name of the current environment.  
  51.  
  52.         ARG([argno[,option]])  
  53.                 Without   parameters,   it   returns   the   number   of
  54.                 parameters.  If only `argno' is specified, it must be  a
  55.                 number, and that parameter is returned.  `Option' can be 
  56.                 either  `E'  or  `O',  and  then  either  `0'  or `1' is
  57.                 returned, depending on whether  the  numbered  parameter
  58.                 existed or was ommitted.  
  59.  
  60.         B2X(binstring)  
  61.  
  62.  
  63.  
  64. Sun Sep 14 17:43:15 1997                                          Page 1
  65.  
  66.  
  67.  
  68.  
  69. rexx (1)               Commands and Applications                rexx (1)
  70.  
  71.  
  72.  
  73.                 Converts the bin-string `binstring' to a hex-string.  
  74.  
  75.         BITAND(string1[,[string2][,padchar]])  
  76.                 Returns  a  string  which  is the bitwise AND of its two
  77.                 first parameters.  The shorter  string  is  padded  with
  78.                 `padchar'.  
  79.  
  80.         BITOR(string1[,[string2][,padchar]])  
  81.                 Like `BITAND' but uses logical OR.  
  82.  
  83.         BITXOR(string1[,[string2][,padchar]])  
  84.                 Like `BITAND' but uses logical XOR.  
  85.  
  86.         C2D(string[,length])  
  87.                 Converts  the  character  string  `string'  to a decimal
  88.                 number.  `Length' specifies the number of characters  in
  89.                 `string' to convert.  
  90.  
  91.         C2X(string)  
  92.                 Converts the character string `string' to a hex-string.  
  93.  
  94.         CENTER(string,length[,padchar])  
  95.  
  96.         CENTRE(string,length[,padchar])  
  97.                 Centers  `string'  in  a  string of `length' characters,
  98.                 using `padchar' for padding, if neccessary.  
  99.  
  100.         CHARIN([streamid][,[start][,length]])  
  101.                 Read `length' (default is 1) characters  from  an  input
  102.                 stream   (default   is   the   standard  input  stream),
  103.                 optionally starting at position `start' (default is  the
  104.                 current read position).  
  105.  
  106.         CHAROUT([streamid][,[string][,start]])  
  107.                 Writes  `stream'  to  an  output  stream (default is the
  108.                 standard output stream), starting  at  position  `start'
  109.                 (default is the current write position).  
  110.  
  111.         CHARS([streamid])  
  112.                 Returns  the  number  of  characters  left  in the input
  113.                 stream (default is the standard input stream).  
  114.  
  115.         COMPARE(string1,string2[,padchar])  
  116.                 Returns `0' or `1', depending on whether the two strings 
  117.                 are equal.  The shorter string is padded with `padchar', 
  118.                 or space if padchar is ommitted.  
  119.  
  120.         CONDITION([option])  
  121.                 Performs  various  operations  on  streams,  see   other
  122.                 documentation.  
  123.  
  124.         COPIES(string,copies)  
  125.                 Returns `copies' copies of the string `string'.  
  126.  
  127.  
  128.  
  129.  
  130. Sun Sep 14 17:43:15 1997                                          Page 2
  131.  
  132.  
  133.  
  134.  
  135. rexx (1)               Commands and Applications                rexx (1)
  136.  
  137.  
  138.  
  139.         DATATYPE(string[,option])  
  140.                 Returns  the  datatype  of  `string':  `NUM'  if it is a
  141.                 number, `LIT' if it is as valid literal  that  does  not
  142.                 have  a  variable  value, `VAR' if it is a variable, and
  143.                 `BAD' otherwise.  If `option' is specified, it  must  be
  144.                 one  of  these  four,  and  then `0' or `1' is returned,
  145.                 depending on whether `string' is of the named type.  
  146.  
  147.         DATE([option])  
  148.                 Returns the date, in various formats, which can be Base, 
  149.                 Century,  Days,  European,   Month,   Normal,   Ordered,
  150.                 Standard, USA, or Weekday.  
  151.  
  152.         DELSTR(string,start[,length])  
  153.                 Deletes  the  substring of `string' starting at position
  154.                 `start' and having a length of `length' (default is  the
  155.                 rest of the string).  
  156.  
  157.         DELWORD(string,start[,length])  
  158.                 Deletes  `length'  words  (default  is  the  rest of the
  159.                 string) from `string', starting at word number `start' 
  160.  
  161.         DIGITS()  
  162.                 Returns the current setting of NUMERIC DIGITS.  
  163.  
  164.         D2C(integer[,length])  
  165.                 Converts the decimal number  `integer'  to  a  character
  166.                 string of length `length'.  
  167.  
  168.         D2X(integer[,length])  
  169.                 Converts the decimal number `integer' to a hex-string of 
  170.                 length `length'.  
  171.  
  172.         ERRORTEXT(errno)  
  173.                 Returns  the  error  text  associated  with error number
  174.                 `errno'.  
  175.  
  176.         FORM()  
  177.                 Returns the current setting of NUMERIC FORM.  
  178.  
  179.         FORMAT(number[,[before][,[after][,[expp][,[expt]]]]])  
  180.                 Formats `number' into a string  having  `before'  digits
  181.                 before and  `after' digits after the decimal point.  The
  182.                 `expp'  and  `expt'  governs  how  and   when   to   use
  183.                 exponential form.  
  184.  
  185.         FUZZ()  
  186.                 Returns the current setting of NUMERIC FUZZ.  
  187.  
  188.         INSERT(string1,string2[,position[,length[,padchar]]])  
  189.                 Inserts  `string1' into `string2' at position `position'
  190.                 and with a length of `length'.  
  191.  
  192.         LASTPOS(needle,haystack[,start])  
  193.  
  194.  
  195.  
  196. Sun Sep 14 17:43:15 1997                                          Page 3
  197.  
  198.  
  199.  
  200.  
  201. rexx (1)               Commands and Applications                rexx (1)
  202.  
  203.  
  204.  
  205.                 Seeks for `needle' in `haystack', from the  end  towards
  206.                 the start.  
  207.  
  208.         LEFT(string,length[,padchar])  
  209.                 Returns the `length' leftmost characters in `string' 
  210.  
  211.         LENGTH(string)  
  212.                 Returns the number of characters in `string'.  
  213.  
  214.         LINEIN([streamid][,[line][,count]])  
  215.                 Reads  a  line  from  an  input  stream  (default is the
  216.                 standard input stream), optionally starting  at  `line'.
  217.                 If  `count'  is  zero,  no  reading  is  performed (only
  218.                 repositioning).  
  219.  
  220.         LINEOUT([streamid][,[string][,line]])  
  221.                 Writes the line `string' to an output stream (default is 
  222.                 the  standard  output  stream,  optionally  starting  at
  223.                 `line'.  
  224.  
  225.         LINES([streamid])  
  226.                 Returns  the  number  of complete lines left in an inpu